Display appropriate GUI that accurately displays offline by design #9883

Vlatombe · 2024-10-17T08:49:24Z

Reworked computer icon and associated descriptions to be controlled by the OfflineCause implementation. For implementations such as RetentionStrategy.Demand, this allows to set an offline cause that can't be interpreted by the end user as an error.

Allow the retention strategy to set an offline cause. For the on-demand retention strategy, this allows to provide a reason why the agent is offline, instead of leaving the agent offline with no message.
Introduced pause and computer-paused symbols, used by the on-demand retention strategy to indicate the computer is offline on purpose and is not in error state
Add getOfflineCause to IComputer and refactor related methods to pull up methods that make sense at the interface level.
Extract IOfflineCause interface from OfflineCause to make it possible to render offline causes in other runtimes (CloudBees CI HA)

Screenshots

Description	Before	After
On-demand agent offline before any connection attempt
Agent overview
Agent temporary offline
Agent tooltip when offline due to idle	No tooltip
Agent tooltip when temporary offline	No tooltip

See JENKINS-XXXXX.

Testing done

Proposed changelog entries

The agents online/offline status and icon can now be influenced by the offline cause, giving better information to users as well as clarifying some use cases when an agent was offline by design and not because of a configuration or technical error.

Proposed upgrade guidelines

N/A

Submitter checklist

Give feedback

The Jira issue, if it exists, is well-described.
The changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developers, depending on the change) and are in the imperative mood (see examples). Fill in the Proposed upgrade guidelines section only if there are breaking changes or changes that may require extra steps from users during upgrade.
There is automated testing or an explanation as to why this change has no tests.
New public classes, fields, and methods are annotated with @Restricted or have @since TODO Javadocs, as appropriate.
New deprecations are annotated with @Deprecated(since = "TODO") or @Deprecated(forRemoval = true, since = "TODO"), if applicable.
New or substantially changed JavaScript is not defined inline and does not call eval to ease future introduction of Content Security Policy (CSP) directives (see documentation).
For dependency updates, there are links to external changelogs and, if possible, full differentials.
For new APIs and extension points, there is a link to at least one consumer.
Options

Desired reviewers

@mention

Before the changes are marked as ready-for-merge:

Maintainer checklist

Give feedback

There are at least two (2) approvals for the pull request and no outstanding requests for change.
Conversations in the pull request are over, or it is explicit that a reviewer is not blocking the change.
Changelog entries in the pull request title and/or Proposed changelog entries are accurate, human-readable, and in the imperative mood.
Proper changelog labels are set so that the changelog can be generated automatically.
If the change needs additional upgrade steps from users, the upgrade-guide-needed label is set and there is a Proposed upgrade guidelines section in the pull request title (see example).
If it would make sense to backport the change to LTS, a Jira issue must exist, be a Bug or Improvement, and be labeled as lts-candidate to be considered (see query).
Options

Reworked computer icon and associated descriptions to be controlled by the `OfflineCause` implementation. For implementations such as `RetentionStrategy.Demand`, this allows to set an offline cause that can't be interpreted by the end user as an error. Introduced `pause` and `computer-paused` symbols, used by the on-demand retention strategy to indicate the computer is offline on purpose and is not in error state Add `getOfflineCause` to `IComputer` and refactor related methods to pull up methods that make sense at the interface level. Extract `IOfflineCause` interface from `OfflineCause`.

mawinter69 · 2024-10-17T09:16:36Z

Could you add the new icon to https://github.com/jenkinsci/jenkins/blob/master/core/src/main/resources/hudson/model/ComputerSet/_legend.jelly
and probably update the not-accepting texts

Vlatombe · 2024-10-17T09:35:22Z

I have never even seen that "legend" popup. TIL

Vlatombe · 2024-10-17T10:03:10Z

probably update the not-accepting texts

Actually not needed. The existing on-demand retention strategy was putting the agent offline, whereas the current scheduled retention strategy just marks it as suspended (so it actually is connected but can't be used).

core/src/main/resources/jenkins/agents/Messages_cs.properties

timja · 2024-10-18T10:05:22Z

core/src/main/java/hudson/slaves/OfflineCause.java

@@ -212,5 +222,28 @@ public static class IdleOfflineCause extends SimpleOfflineCause {
        public IdleOfflineCause() {
            super(hudson.slaves.Messages._RetentionStrategy_Demand_OfflineIdle());


If this wasn't shown before and now is I'd suggest changing the text from computer to agent

Offline because computer was idle doesn't make sense as a computer isn't user facing terminology, (not mentioned in https://www.jenkins.io/doc/book/glossary/), it should be agent instead.

This was already shown before, just not before the agent was online, then became offline again as instructed by the retention strategy.

timja · 2024-10-18T19:00:29Z

can you add a changelog entry please

timja

/label ready-for-merge

This PR is now ready for merge, after ~24 hours, we will merge it if there's no negative feedback.

Thanks!

Vlatombe added the developer Changes which impact plugin developers label Oct 17, 2024

Vlatombe requested a review from jglick October 17, 2024 08:49

Vlatombe added rfe For changelog: Minor enhancement. use `major-rfe` for changes to be highlighted and removed developer Changes which impact plugin developers labels Oct 17, 2024

Add paused to _legend.jelly

3983ac6

jglick reviewed Oct 17, 2024

View reviewed changes

core/src/main/resources/jenkins/agents/Messages_cs.properties Outdated Show resolved Hide resolved

Fix l18n resources encoding

ab9f21f

Vlatombe requested review from jglick and a team October 18, 2024 09:23

timja reviewed Oct 18, 2024

View reviewed changes

jglick approved these changes Oct 18, 2024

View reviewed changes

Vlatombe requested a review from timja October 22, 2024 07:58

timja approved these changes Oct 22, 2024

View reviewed changes

comment-ops-bot bot added the ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback label Oct 22, 2024

timja merged commit d9fbb65 into jenkinsci:master Oct 23, 2024
16 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Display appropriate GUI that accurately displays offline by design #9883

Display appropriate GUI that accurately displays offline by design #9883

Vlatombe commented Oct 17, 2024 •

edited

Loading

Submitter checklist

Maintainer checklist

mawinter69 commented Oct 17, 2024

Vlatombe commented Oct 17, 2024

Vlatombe commented Oct 17, 2024

timja Oct 18, 2024

Vlatombe Oct 18, 2024

timja commented Oct 18, 2024

timja left a comment

		@@ -212,5 +222,28 @@ public static class IdleOfflineCause extends SimpleOfflineCause {
		public IdleOfflineCause() {
		super(hudson.slaves.Messages._RetentionStrategy_Demand_OfflineIdle());

Display appropriate GUI that accurately displays offline by design #9883

Display appropriate GUI that accurately displays offline by design #9883

Conversation

Vlatombe commented Oct 17, 2024 • edited Loading

Testing done

Proposed changelog entries

Proposed upgrade guidelines

Submitter checklist

Desired reviewers

Maintainer checklist

mawinter69 commented Oct 17, 2024

Vlatombe commented Oct 17, 2024

Vlatombe commented Oct 17, 2024

timja Oct 18, 2024

Choose a reason for hiding this comment

Vlatombe Oct 18, 2024

Choose a reason for hiding this comment

timja commented Oct 18, 2024

timja left a comment

Choose a reason for hiding this comment

Vlatombe commented Oct 17, 2024 •

edited

Loading